Interface VirtualTemplateManager

All Superinterfaces:
IPCObject, Process
All Known Implementing Classes:
VirtualTemplateManagerImpl

public interface VirtualTemplateManager extends Process
Information provided by the PKI file:

    \class VirtualTemplateManager
    
    \brief VirtualTemplateManager manages and manipulates virtual template interfaces for PPPoE.
    
    \example network().getDevice("Router0").getProcess("VirtualTemplateManager")
    
Author:
Auto-generated
  • Method Details

    • addVirtualTempIntByNum

      VirtualTemplateInterface addVirtualTempIntByNum(int number)
      Information provided by the PKI file:
      
          \brief Adds a virtual template interface.
          
          \param number, the interface number for the virtual template interface.
          
              
      Parameters:
      number - Takes in a parameter of number
      Returns:
      VirtualTemplateInterface Returns a VirtualTemplateInterface
    • removeVirtualTempByNum

      void removeVirtualTempByNum(int number)
      Information provided by the PKI file:
      
          \brief Removes the virtual template interface with the specified interface number.
          
          \param number, the interface number of the virtual template interface of interest.
          
              
      Parameters:
      number - Takes in a parameter of number
    • getVirtualTempIntByNum

      VirtualTemplateInterface getVirtualTempIntByNum(int number)
      Information provided by the PKI file:
      
          \brief Returns the virtual template interface with the specified interface number.
          
          \param number, the interface number of the virtual template interface of interest.
          
          \return VirtualTemplateInterface, the VirtualTemplateInterface object with the specified interface number.
          
              
      Parameters:
      number - Takes in a parameter of number
      Returns:
      VirtualTemplateInterface Returns a VirtualTemplateInterface
    • getIntCount

      int getIntCount()
      Information provided by the PKI file:
      
          \brief Returns the number of virtual template interfaces.
          
          \return int, the number of virtual template interfaces.
          
              
      Returns:
      int Returns a int
    • getIntAt

      VirtualTemplateInterface getIntAt(int number)
      Information provided by the PKI file:
      
          \brief Returns the virtual template interface at the specified index.
          
          \param number, the index of the virtual template interface of interest.
          
          \return VirtualTemplateInterface, the VirtualTemplateInterface object at the specified index.
          
              
      Parameters:
      number - Takes in a parameter of number
      Returns:
      VirtualTemplateInterface Returns a VirtualTemplateInterface
    • addVpdnGroupByName

      void addVpdnGroupByName(String name)
      Information provided by the PKI file:
      
          \brief Adds a VPDN group.
          
          \param name, the name for the VPDN group.
          
              
      Parameters:
      name - Takes in a parameter of name
    • removeVpdnGroupByName

      void removeVpdnGroupByName(String name)
      Information provided by the PKI file:
      
          \brief Removes the VPDN group with the specified name.
          
          \param name, the name of the VPDN group of interest.
          
              
      Parameters:
      name - Takes in a parameter of name
    • getVpdnGroupByName

      VpdnGroup getVpdnGroupByName(String name)
      Information provided by the PKI file:
      
          \brief Returns the VPDN group with the specified name.
          
          \param name, the name of the VPDN group of interest.
          
          \return VpdnGroup, the VpdnGroup object with the specified name.
          
              
      Parameters:
      name - Takes in a parameter of name
      Returns:
      VpdnGroup Returns a VpdnGroup
    • getVpdnGroupCount

      int getVpdnGroupCount()
      Information provided by the PKI file:
      
          \brief Returns the number of VPDN groups.
          
          \param int, the number of VPDN groups.
          
              
      Returns:
      int Returns a int
    • getVpdnGroupAt

      VpdnGroup getVpdnGroupAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the VPDN group at the specified name.
          
          \param index, the index of the VPDN group of interest.
          
          \return VpdnGroup, the VpdnGroup object at the specified name.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      VpdnGroup Returns a VpdnGroup
    • setVpdnEnable

      void setVpdnEnable(boolean flag)
      Information provided by the PKI file:
      
          \brief Enables or disables VPDN.
          
          \param flag, true to enable VPDN, false to disable it.
          
              
      Parameters:
      flag - Takes in a parameter of flag
    • isVpdnEnable

      boolean isVpdnEnable()
      Information provided by the PKI file:
      
          \brief Returns true if VPDN is enabled, otherwise false.
          
          \return bool, true if VPDN is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean